/**
 * Copyright (c) 2008, Mu Dynamics.
 *  All rights reserved.
 *  
 *   Redistribution and use in source and binary forms, with or without modification, 
 *   are permitted provided that the following conditions are met:
 *   
 *  - Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation and/or 
 *     other materials provided with the distribution.
 *  - Neither the name of the "Mu Dynamics" nor the names of its contributors may be used 
 *     to endorse  or promote products derived from this software without specific prior 
 *     written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.mu.jacob.core.renderer;

import java.util.Map;

import org.apache.velocity.tools.generic.AlternatorTool;
import org.apache.velocity.tools.generic.DateTool;
import org.apache.velocity.tools.generic.IteratorTool;
import org.apache.velocity.tools.generic.ListTool;
import org.apache.velocity.tools.generic.NumberTool;
import org.apache.velocity.tools.generic.RenderTool;
import org.apache.velocity.tools.generic.SortTool;
import org.apache.velocity.tools.generic.ValueParser;

/**
 * Velocity context tools provider.
 * This tools can be referenced in templates
 * using <code>tools</code> variable, for example
 * ${tools.stringTool.firstToUpperCase(...)} calls
 * firstToUpperCase on StringTools.
 * 
 * @author Adam Smyczek
 *
 */
public class ContextTools {

	private static ContextTools instance = null;
	
	public static ContextTools getInstance() {
		if (instance  == null) {
			instance = new ContextTools();
		}
		return instance;
	}

	private ContextTools() {
		super();
	}
	
	private StringTool stringTool = null;
	public StringTool getStringTool() {
		if (stringTool == null) {
			stringTool = new StringTool();
		}
		return stringTool;
	}
	
	private AlternatorTool alternatorTool = null;
	public AlternatorTool getAlternatorTool() {
		if (alternatorTool == null) {
			alternatorTool = new AlternatorTool();
		}
		return alternatorTool;
	}

	private DateTool dateTool = null;
	public DateTool getDateTool() {
		if (dateTool == null) {
			dateTool = new DateTool();
		}
		return dateTool;
	}

	private IteratorTool iteratorTool = null;
	public IteratorTool getIteratorTool() {
		if (iteratorTool == null) {
			iteratorTool = new IteratorTool();
		}
		return iteratorTool;
	}

	private ListTool listTool = null;
	public ListTool getListTool() {
		if (listTool == null) {
			listTool = new ListTool();
		}
		return listTool;
	}

	private NumberTool numberTool = null;
	public NumberTool getNumberTool() {
		if (numberTool == null) {
			numberTool = new NumberTool();
		}
		return numberTool;
	}

	private RenderTool renderTool = null;
	public RenderTool getRenderTool() {
		if (renderTool == null) {
			renderTool = new RenderTool();
		}
		return renderTool;
	}

	private SortTool sortTool = null;
	public SortTool getSortTool() {
		if (sortTool == null) {
			sortTool = new SortTool();
		}
		return sortTool;
	}

	public ValueParser getValueParser(Map map) {
		return new ValueParser(map);
	}

}
